Interface WirelessRouter

All Superinterfaces:
CiscoDevice, Device, IPCObject, Router
All Known Implementing Classes:
WirelessRouterImpl

public interface WirelessRouter extends Router
Information provided by the PKI file:

    \class WirelessRouter
    
    \brief WirelessRouter handles and manipulates wireless routers
    
    \example network().getDevice("Wireless Router0")
    
Author:
Auto-generated
  • Method Details

    • setDefaultGateway

      void setDefaultGateway(IPAddress gateway)
      Information provided by the PKI file:
      
          \brief Sets the default gateway.
          
          \param gateway, the IP address of the default gateway.
          
              
      Parameters:
      gateway - Takes in a parameter of gateway
    • setInternetConnectionType

      void setInternetConnectionType(InternetConnectionType type)
      Information provided by the PKI file:
      
          \Sets the Internet connection type.
          
          \param type,        the Internet connection type.
          Internet connection types:  eDhcp = 0,
          ePppoe = 1,
          eStatic = 2
          
              
      Parameters:
      type - Takes in a parameter of type
    • getInternetConnectionType

      InternetConnectionType getInternetConnectionType()
      Information provided by the PKI file:
      
          \Returns the Internet connection type.
          
          \param InternetConnectionType,      the Internet connection type.
          Internet connection types:  eDhcp = 0,
          ePppoe = 1,
          eStatic = 2
          
              
      Returns:
      InternetConnectionType Returns a InternetConnectionType
    • getDefaultGateway

      IPAddress getDefaultGateway()
      Information provided by the PKI file:
      
          \brief Returns the default gateway.
          
          \return ip, the IP address of the default gateway.
          
              
      Returns:
      IPAddress Returns a IPAddress
    • setRemoteManagementEnable

      void setRemoteManagementEnable(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables remote management.
          
          \param bEnable, true to enable remote management, false to disable it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • isRemoteManagementEnable

      boolean isRemoteManagementEnable()
      Information provided by the PKI file:
      
          \brief Returns true if remote management is enabled, otherwise false.
          
          \return bool, true if remote management is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • addNatEntry

      void addNatEntry(String name, int extPort, int intPort, LinksysProtocol protoType, IPAddress ipAddress, boolean bEnable)
      Information provided by the PKI file:
      
          \brief Adds a NAT (port forwarding) entry.
          
          \param name, the name of the NAT entry.
          \param extPort, the Externet port number.
          \param intPort, the Internet port number.
          \param protoType,   the protocol type.
          Protocol types:     eTcp = 0,
          eUdp = 1,
          eBoth = 2
          \param ipAddress, the IP address to forward to.
          \param bEnable, true to enable port forwarding for this entry, false to disable it.
          
              
      Parameters:
      name - Takes in a parameter of name
      extPort - Takes in a parameter of extPort
      intPort - Takes in a parameter of intPort
      protoType - Takes in a parameter of protoType
      ipAddress - Takes in a parameter of ipAddress
      bEnable - Takes in a parameter of bEnable
    • removeNatEntry

      void removeNatEntry(String name, int extPort, int intPort, LinksysProtocol protoType, IPAddress ipAddress, boolean bEnable)
      Information provided by the PKI file:
      
          \brief Removes the specified NAT (port forwarding) entry.
          
          \param name, the name of the NAT entry.
          \param extPort, the Externet port number.
          \param intPort, the Internet port number.
          \param protoType,   the protocol type.
          Protocol types:     eTcp = 0,
          eUdp = 1,
          eBoth = 2
          \param ipAddress, the IP address to forward to.
          \param bEnable, true to enable port forwarding for this entry, false to disable it.
          
              
      Parameters:
      name - Takes in a parameter of name
      extPort - Takes in a parameter of extPort
      intPort - Takes in a parameter of intPort
      protoType - Takes in a parameter of protoType
      ipAddress - Takes in a parameter of ipAddress
      bEnable - Takes in a parameter of bEnable
    • removeAllNatEntries

      void removeAllNatEntries()
      Information provided by the PKI file:
      
          \brief Removes all NAT (port forwarding) entries.
          
              
    • getNatEntryCount

      int getNatEntryCount()
      Information provided by the PKI file:
      
          \brief Returns the number of NAT (port forwarding) entries.
          
          \return int, the number of NAT (port forwarding) entries.
          
              
      Returns:
      int Returns a int
    • getNatEntryAt

      NATConfigEntry getNatEntryAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the NAT configuration at the specified index.
          
          \param index, the index of the NAT configuration of interest.
          
          \return NatConfigEntry, the NatConfigEntry object at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      NATConfigEntry Returns a NATConfigEntry
    • getNatEntries

      List<NATConfigEntry> getNatEntries()
      Information provided by the PKI file:
      
          \brief Returns the list of NAT configurations.
          
          \return vector<NatConfigEntry>, the list of NatConfigEntry objects.
          
              
      Returns:
      List<NATConfigEntry> Returns a List<NATConfigEntry>
    • setFirmwareVersion

      void setFirmwareVersion(String version)
      Information provided by the PKI file:
      
          \brief Sets the firmware version.
          
          \param version, the firmware version.
          
              
      Parameters:
      version - Takes in a parameter of version
    • getFirmwareVersion

      String getFirmwareVersion()
      Information provided by the PKI file:
      
          \brief Returns the firmware version.
          
          \return QString, the firmware version.
          
              
      Returns:
      String Returns a String
    • setDMZEntry

      void setDMZEntry(boolean bEnable, IPAddress ipAddress)
      Information provided by the PKI file:
      
          \brief Adds a DMZ entry.
          
          \param bEnable, true to enable DMZ, false to disable it.
          \param ipAddress, the IP address to place in the DMZ.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
      ipAddress - Takes in a parameter of ipAddress
    • removeDMZEntry

      void removeDMZEntry()
      Information provided by the PKI file:
      
          \brief Removes the DMZ entry.